#include "mb_prot.h"

/* prot 协议私有数据 */
prot_prvt s_prot_prvt = 
{
    /* 历史选择记录全部初始化为 PROT_UNKNOWN */
    .sel_history = PROT_SELS_INIT_CFG, 
    /* 数据协议的行为状态 */
    .action_status = {MB_FALSE_DEF, MB_FALSE_DEF, MB_FALSE_DEF, MB_FALSE_DEF},
    /* 当前接收到的帧的类型 */
    .CUR_FORMAT_TYPE = PROT_FORMAT_UNKNOWN,
};

/* ------------------------------------------------------------- */

/* 选择 prot 数据协议 (现在默认只使用XModem, sel 无效) */
static int mb_prot_select(PROT_SELECT sel)
{
    int i;

    /* 判断是否已经选择过设备 */
    for (i = 0; i < sizeof(s_prot_prvt.sel_history); i++)
    {
        
        if (s_prot_prvt.sel_history[i] == sel)
        {
            return -1;  /* sel 在 当前系统中 已被选择(处于可用状态) */
        }
    }

    /* 是新的协议选择 */
    s_prot_prvt.cursel = sel;

/* 暂不支持 YMODEM 协议 */
if (sel == PROT_YMODEM)
{
    return -1;
}

    return 0;
}

/* 初始化数据帧中固定的数据值 */
static int mb_prot_format_var_init(void)
{
    s_prot_prvt.format_var.head        = PROT_DX_FORMAT_SOH;
    s_prot_prvt.format_var.new_index   = 0;
    s_prot_prvt.format_var.payload_len = PROI_DX_PAYLOAD_LEN;

    return 0;
}

/* ----------------- 协议具体操作 (不向上层展示) ----------------- */

/* CRC余式表 */
static const uint16_t prot_crc16_table[256] = 
{
    0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
    0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
    0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
    0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
    0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
    0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
    0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
    0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
    0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
    0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
    0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
    0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
    0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
    0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
    0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
    0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
    0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
    0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
    0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
    0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
    0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
    0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
    0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
    0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
    0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
    0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
    0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
    0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
    0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
    0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
    0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
    0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0
};

/* 计算CRC16 */
static uint16_t mb_prot_prvt_crc16(mb_buf_attr buf_attr)
{
    int      i;
    uint16_t output = 0x0000;

    /* 查表法计算 CRC16 */
    for (i = 0; i < buf_attr.len; i++)
    {
        output = (output << 8) ^ \
                 prot_crc16_table[((output >> 8) ^ buf_attr.buf[i]) & 0xFF];
    }

    return output;
}

/* 请求开始通信 */
static int mb_prot_prvt_request_start(void)
{
    cmc_op *      carrier_op;
    mb_buf_attr * txbuf_attr;
    mb_buf_attr   buf_attr;
    uint8_t       sbyte;

    /* 获得 数据通道操作函数接口 */
    carrier_op = s_prot_prvt.carrier;

    if (carrier_op == NULL)
    {
        return -1;
    }

    /* 设置数据通道的发送缓冲区信息 */
    buf_attr.buf = s_prot_prvt.tx_buf;
    buf_attr.len = sizeof(s_prot_prvt.tx_buf);
    s_prot_prvt.carrier->set_txbuf_attr(&buf_attr);

    /* 获得发送缓冲区信息 */
    txbuf_attr = carrier_op->get_txbuf();

    if (txbuf_attr == NULL)
    {
        return -1;
    }

    sbyte = PROT_DX_SBYTE_REQUEST;

    /* 填充指令数据 */
    memcpy(txbuf_attr->buf, &sbyte, sizeof(sbyte));
    txbuf_attr->len = sizeof(sbyte);

    /* 通过数据通道发出 */
    carrier_op->put_data(txbuf_attr);
    
    return 0;
}

/* 开始接收数据 */
static int mb_prot_prvt_start_recv(void)
{
    cmc_op *    carrier_op;
    mb_buf_attr buf_attr;
    
    /* 获得 数据通道操作函数接口 */
    carrier_op = s_prot_prvt.carrier;

    if (carrier_op == NULL)
    {
        return -1;
    }

    /* 通过通道接收数据 */
    if (s_prot_prvt.action_status.is_start_recv != MB_TRUE)
    {
        /* 设置数据通道的接收缓冲区信息 */
        buf_attr.buf = s_prot_prvt.rx_buf;
        buf_attr.len = sizeof(s_prot_prvt.rx_buf);
        s_prot_prvt.carrier->set_rxbuf_attr(&buf_attr);

        carrier_op->start_recv();    /* 开始接收数据 */
        s_prot_prvt.action_status.is_start_recv = MB_TRUE;
    }
    
    return 0;
}

/* 复位接收数据动作的状态 */
static void mb_prot_prvt_reset_recv_status(void)
{
    /* 通过通道接收数据 */
    s_prot_prvt.action_status.is_start_recv = MB_FALSE;

    return;
}


/* 判断是否收到数据 */
static MB_STATUS mb_prot_prvt_check_is_rxed(void)
{
    MB_STATUS  is_rxed;
    cmc_op *   carrier_op;

    /* 获得 数据通道操作函数接口 */
    carrier_op = s_prot_prvt.carrier;

    if (carrier_op == NULL)
    {
        return MB_FALSE;
    }

    /* 获得是否收到数据的状态 */
    is_rxed = carrier_op->check_is_rxed();

    return is_rxed;
}

/* 获取接收到的数据 */
static mb_buf_attr *mb_prot_prvt_get_data(void)
{
    cmc_op *      carrier_op;
    mb_buf_attr * buf_attr = NULL;

    /* 获得 数据通道操作函数接口 */
    carrier_op = s_prot_prvt.carrier;

    if (carrier_op == NULL)
    {
        return NULL;
    }

    /* 获取接收到的数据 */
    buf_attr = carrier_op->get_data();

    return buf_attr;
}

/* 发送应答状态 */
static int mb_prot_prvt_send_ack_status(MB_STATUS is_ack)
{
    cmc_op *      carrier_op;
    mb_buf_attr * txbuf_attr;
    mb_buf_attr   buf_attr;
    uint8_t       sbyte;

    /* 获得 数据通道操作函数接口 */
    carrier_op = s_prot_prvt.carrier;

    if (carrier_op == NULL)
    {
        return -1;
    }

    /* 设置数据通道的发送缓冲区信息 */
    buf_attr.buf = s_prot_prvt.tx_buf;
    buf_attr.len = sizeof(s_prot_prvt.tx_buf);
    s_prot_prvt.carrier->set_txbuf_attr(&buf_attr);

    /* 获得发送缓冲区信息 */
    txbuf_attr = carrier_op->get_txbuf();

    if (txbuf_attr == NULL)
    {
        return -1;
    }

    sbyte = (is_ack == MB_TRUE) ? \
            PROT_DX_SBYTE_ACK : PROT_DX_SBYTE_NACK;

    /* 填充指令数据 */
    memcpy(txbuf_attr->buf, &sbyte, sizeof(sbyte));
    txbuf_attr->len = sizeof(sbyte);

    /* 通过数据通道发出 */
    carrier_op->put_data(txbuf_attr);
    
    return 0;
}

/* 判断是否发送完数据 */
#if 0
static MB_STATUS mb_prot_prvt_check_is_txed(void)
{
    MB_STATUS  is_rxed;
    cmc_op *   carrier_op;

    /* 获得 数据通道操作函数接口 */
    carrier_op = s_prot_prvt.carrier;

    if (carrier_op == NULL)
    {
        return MB_FALSE;
    }

    /* 获得数据发送的状态 */
    is_rxed = carrier_op->check_is_txed();

    return is_rxed;
}
#endif

/* 从数据帧中解析出有效的数据 */
static mb_buf_attr *mb_prot_prvt_parse(mb_buf_attr * buf_attr, MB_STATUS * ack_status)
{
    prot_format   format;
    uint16_t      crc;
    uint8_t       sbyte;
    uint8_t       last_index, cur_index;

    /* 参数判断 */
    if (buf_attr == NULL)
    {
        return NULL;
    }

    /* 判断接收到的字节个数 (数据帧 / 指令帧) */
    if (buf_attr->len != PROT_SBYTE_LEN)
    {
        format.head        = buf_attr->buf[0];
        format.index       = buf_attr->buf[1];
        format.invindex    = buf_attr->buf[2];
        format.payload     = &buf_attr->buf[3];                     /*有效数据起始地址*/
        format.payload_len = s_prot_prvt.format_var.payload_len;    /* 有效数据个数 */
        format.crc_h       = *(format.payload + format.payload_len);
        format.crc_l       = *(format.payload + format.payload_len + 1);
    }
    else
    {
        sbyte = buf_attr->buf[0];

        /* 单字节指令匹配 */
        if ((sbyte != PROT_DX_SBYTE_EOT) && \
            (sbyte != PROT_DX_SBYTE_CAN))
        {
            /* 当前帧是未知帧 */
            s_prot_prvt.CUR_FORMAT_TYPE = PROT_FORMAT_UNKNOWN;
            *ack_status = MB_FALSE;    /* 本帧无效 */

            return NULL;
        }
    
        /* 判断是否是结束帧 */
        if (sbyte == PROT_DX_SBYTE_EOT)
        {
            /* 当前帧是结束帧 */
            s_prot_prvt.CUR_FORMAT_TYPE = PROT_FORMAT_EOT;
            *ack_status = MB_TRUE;    /* 本帧有效 */

            return NULL;
        }
        
        /* 判断是否是终止传输帧 */
        if (sbyte == PROT_DX_SBYTE_CAN)
        {
            /* 当前帧是终止传输帧 */
            s_prot_prvt.CUR_FORMAT_TYPE = PROT_FORMAT_CAN;
            *ack_status = MB_TRUE;    /* 本帧有效 */

            return NULL;
        }
    }
    
    /* 帧头匹配 */
    if (format.head != s_prot_prvt.format_var.head)
    {
        /* 当前帧是未知帧 */
        s_prot_prvt.CUR_FORMAT_TYPE = PROT_FORMAT_UNKNOWN;
        *ack_status = MB_FALSE;    /* 本帧无效 */

        return NULL;
    }

    /* 以下当前帧是数据帧 */
    s_prot_prvt.CUR_FORMAT_TYPE = PROT_FORMAT_DATA;

    /* 检测帧序字节的连续性 (范围: 0x01~0xFE 周而复始) */
    last_index = s_prot_prvt.format_var.new_index;
    cur_index  = format.index;
    
    if ((cur_index <= 0xFE) && (cur_index != 0x01)) /* 帧序号未溢出 */
    {
        /* 为什么会在传输进度到80%多的时候收到一帧 cur_index == 0x00 ?????? */
        if (cur_index != 0 && (last_index != 0xFF))
        {
            if ((cur_index - last_index) != 1)
            {
                *ack_status = MB_FALSE;    /* 本帧无效 */

                return NULL;    /* 帧序号不是连续的 */
            }
        }
    }
    else if (cur_index == 0x01)  /* 帧序号可能溢出 */
    {
        /* last > cur (说明帧序号溢出了, 所以 last == 0xFE 时才是连续的) */
        if ((last_index > cur_index) && (last_index != 0xFE))
        {
            *ack_status = MB_FALSE;    /* 本帧无效 */
            return NULL;    /* 帧序号不是连续的 */
        }
    }

    /* 检测帧序字节的有效性 */
    if (format.invindex != (uint8_t)(~format.index))
    {
        *ack_status = MB_FALSE;    /* 本帧无效 */

        return NULL; /* 帧序号无效 */
    }

    /* 计算CRC的值, 并与数据帧里的值比对 */
    s_prot_prvt.parsed_buf.buf = format.payload;     /* 从 payload开始 */
    s_prot_prvt.parsed_buf.len = format.payload_len; /* 计算长度 */

    crc = mb_prot_prvt_crc16(s_prot_prvt.parsed_buf);

    if ((((crc & 0xFF00) >> 8) != format.crc_h) || \
        ((crc & 0xFF) != format.crc_l))
    {
        *ack_status = MB_FALSE;    /* 本帧无效 */

        return NULL;    /* CRC 校验值不通过 */
    }

    *ack_status = MB_TRUE;    /* 本帧有效 */

    /* 有效帧的序号才被跟新到相关变量 */
    s_prot_prvt.format_var.new_index = cur_index;

    /* 返回有效数据缓冲区信息 */
    return &s_prot_prvt.parsed_buf;
}

/* 如果是填充帧, 则重新设置缓冲区信息 */
static mb_buf_attr *mb_prot_prvt_process_if_filled(mb_buf_attr * buf_attr)
{
    uint8_t   *pseek;
    int       i, seek_cnt = 0, mark_cnt = 0;
    MB_STATUS RSTATUS = MB_UNKNOWN;

    /* buf_attr == NULL 时, 即收到的是单字节命令 */
    if (buf_attr == NULL)
    {
        return NULL;
    }

    /* 定位到最后一个字节 */
    pseek = (buf_attr->buf + (buf_attr->len - 1));

    /* 从后往前查找 PROT_DX_DATA_FILL_MARK 的个数 */
    for (i= 0; i < buf_attr->len; i++)
    {
        seek_cnt++; /* 寻找次数 */

        if (*pseek == PROT_DX_DATA_FILL_MARK)
        {
            mark_cnt++;     /* 标记个数+1 */
        }

        pseek--;            /* 定位到上一个数据 */

        /* 在 PROT_CHECK_FILL_MARK_MAX_NBR 次数之内, 判断是否是填充帧 */
        if ((mark_cnt == seek_cnt) && \
            (mark_cnt >= PROT_CHECK_FILL_MARK_MAX_NBR))
        {
            /* 找了几次就找到几次 mark, 且 mark 次数满足最低识别要求次数 */
            RSTATUS = MB_TRUE;  /* 判断是填充帧 */
        }
        else if ((seek_cnt >= PROT_CHECK_FILL_MARK_MAX_NBR) && \
                 (RSTATUS != MB_TRUE))
        {
            /* 找的次数已超过 最低识别要求的次数 */
            RSTATUS = MB_FALSE;  /* 判断是填充帧 */
        }

        /* 算填字节的个数:
         * 当已经判定为 填充帧后, 
         * 当 seek_cnt - mark_cnt == 1 时, 表示检测到了第一个非 MAKR 值 
         */
        if ((seek_cnt - mark_cnt == 1) && (RSTATUS == MB_TRUE))
        {
            break;
        }
    }

    /* 判断是否是填充帧, 并处理 */
    if (RSTATUS == MB_TRUE)
    {
        buf_attr->len = (buf_attr->len - mark_cnt);
    }

    return buf_attr;
}

/* 协议状态数据复位 */
static void mb_prot_prvt_data_init(void)
{
    /* 复位数据协议的行为状态 */
    s_prot_prvt.action_status.is_requested  = MB_FALSE;
    s_prot_prvt.action_status.is_start_recv = MB_FALSE;
    s_prot_prvt.action_status.is_respond    = MB_FALSE;
    s_prot_prvt.action_status.is_geted      = MB_FALSE;

    return;
}

/* ------------------- 协议操作 (向上层展示) 实现 ------------------- */

/* 初始化数据载体 (即数据传输的通道) */
static int prot_op_carrier_init(cmc_op *op)
{
    /* 为 协议 指定数据通道的操作接口 */
    s_prot_prvt.carrier = op;

    if (s_prot_prvt.carrier == NULL)
    {
        return -1;
    }

    return 0;
}

/* 帧解析出有效数据 */
static mb_buf_attr * prot_op_transfer_and_parse(void)
{
    int             ret;
    MB_STATUS       RSTATUS, ack_status;
    mb_buf_attr *   buf_attr;
    static uint32_t request_period = 0;

    /* 没有收到 master 回应前, 一直发出请求 */
    if (s_prot_prvt.action_status.is_respond != MB_TRUE)
    {
        request_period++;

        if (request_period < PROT_REQUEST_PERIOD_CNT)
        {
            return NULL;
        }

        ret = mb_prot_prvt_request_start();

        request_period = 0; /* 计数值清0 */

        if (ret != 0)
        {
            return NULL;
        }

        /* 标记已开始请求 */
        if (s_prot_prvt.action_status.is_requested != MB_TRUE)
        {
            s_prot_prvt.action_status.is_requested = MB_TRUE;
        }

        /* 开始接收数据 */
        ret = mb_prot_prvt_start_recv();

        if (ret != 0)
        {
            return NULL;
        }
    }
    else
    {
        /* 开始接收数据 */
        ret = mb_prot_prvt_start_recv();

        if (ret != 0)
        {
            return NULL;
        }
    }

    /* 判断是否接收到数据 */
    RSTATUS = mb_prot_prvt_check_is_rxed();

    if (RSTATUS != MB_TRUE)
    {
        return NULL;
    }

    /* 标记已收到 master 回应 (不再发请求), 但是数据没被取走 */
    s_prot_prvt.action_status.is_respond = MB_TRUE;
    s_prot_prvt.action_status.is_geted   = MB_FALSE;

    /* 获取接收到的数据 */
    buf_attr = mb_prot_prvt_get_data();

    if (buf_attr == NULL)
    {
        return NULL;
    }

    /* 标记数据被取走 */
    s_prot_prvt.action_status.is_geted = MB_TRUE;

    /* 从数据帧中解析出有效的数据 */
    s_prot_prvt.p_parsed_buf = mb_prot_prvt_parse(buf_attr, &ack_status);
    
    /* 复位接收数据动作的状态 */
    mb_prot_prvt_reset_recv_status();

    /* 发送应答 / 非应答 */
    mb_prot_prvt_send_ack_status(ack_status);
    
    /* 等待数据发送完毕 */
    /*  */

    /* 如果是填充帧, 则重新设置缓冲区信息 */
    s_prot_prvt.p_parsed_buf = \
    mb_prot_prvt_process_if_filled(s_prot_prvt.p_parsed_buf);

    /* 返回被解析出的有效数据 */
    return s_prot_prvt.p_parsed_buf;
}

/* 获得数据传输状态 */
static MB_XFR_STATUS prot_op_get_xfr_status(void)
{
    MB_XFR_STATUS XFR_STATUS;

    /* 判断当前是否是结束帧 */
    if (s_prot_prvt.CUR_FORMAT_TYPE == PROT_FORMAT_EOT)
    {
        XFR_STATUS = MB_XFR_FINISHED;    /* 数据传输完成 */
    }
    /* 判断当前是否是取消帧 */
    else if (s_prot_prvt.CUR_FORMAT_TYPE == PROT_FORMAT_CAN)
    {
        XFR_STATUS = MB_XFR_CANCELED;    /* 数据传输被取消 */
    }
    /* 判断当前是否是数据帧 */
    else if (s_prot_prvt.CUR_FORMAT_TYPE == PROT_FORMAT_DATA)
    {
        XFR_STATUS = MB_XFR_ING;         /* 数据正在传输 */
    }
    else
    {
        /* 判断是否已经发过请求 */
        if (s_prot_prvt.action_status.is_requested == MB_TRUE)
        {
            XFR_STATUS = MB_XFR_START;
        }

        /* 如果已经得到回应, 则 状态进一步确认为传输中 */
        if (s_prot_prvt.action_status.is_respond == MB_TRUE)
        {
            XFR_STATUS = MB_XFR_ING;
        }
    }

    /* 协议状态数据复位 (准备下次数据传输) */
    if ((XFR_STATUS == MB_XFR_FINISHED) || (XFR_STATUS == MB_XFR_CANCELED))
    {
        mb_prot_prvt_data_init();
    }

    return XFR_STATUS;    /* 数据传输已完成 */
}

/* ----------------------------- 注册指定的PROT操作函数接口 ----------------------------- */

/* prot 协议操作接口 */
prot_op s_prot_op =
{
    .carrier_init       = prot_op_carrier_init,
    .transfer_and_parse = prot_op_transfer_and_parse,
    .get_xfr_status     = prot_op_get_xfr_status,
};

/* 注册 prot 操作 */
prot_op_t mb_prot_op_register(PROT_SELECT sel)
{
    int ret;

    /* 判断参数有效性 */
    if (sel >= PROT_UNKNOWN)
    {
        return NULL;    /* 注册失败 */
    }

    /* 选择 prot 数据协议 (暂时无效, 只支持一种) */
    ret = mb_prot_select(sel);

    if (ret != 0)
    {
        return NULL;    /* 数据协议选择失败, 已被选择(处于可用状态) */
    }

    /* 初始化数据帧中固定的数据值 (根据协议初始化) */
    mb_prot_format_var_init();

    return &s_prot_op;
}
